<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - IndexPage</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/AndroidKeyHandler.html">AndroidKeyHandler</a></li>
	
	<li><a href="../symbols/FocusableItem.html">FocusableItem</a></li>
	
	<li><a href="../symbols/FocusController.html">FocusController</a></li>
	
	<li><a href="../symbols/FullscreenPage.html">FullscreenPage</a></li>
	
	<li><a href="../symbols/GenericVideoPlayerController.html">GenericVideoPlayerController</a></li>
	
	<li><a href="../symbols/GridController.html">GridController</a></li>
	
	<li><a href="../symbols/GridFocusableItem.html">GridFocusableItem</a></li>
	
	<li><a href="../symbols/IndexPage.html">IndexPage</a></li>
	
	<li><a href="../symbols/NativeVideoPlayerController.html">NativeVideoPlayerController</a></li>
	
	<li><a href="../symbols/SideMenuFocusableItem.html">SideMenuFocusableItem</a></li>
	
	<li><a href="../symbols/SideNavController.html">SideNavController</a></li>
	
	<li><a href="../symbols/VideoCommandFocusableItem.html">VideoCommandFocusableItem</a></li>
	
	<li><a href="../symbols/VideoControlsController.html">VideoControlsController</a></li>
	
	<li><a href="../symbols/VideoDAO.html">VideoDAO</a></li>
	
	<li><a href="../symbols/VideoDataController.html">VideoDataController</a></li>
	
	<li><a href="../symbols/WebVideoPlayerController.html">WebVideoPlayerController</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class IndexPage
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/Workspace_web-to-native-web-app_http-client_js_index.js.html">index.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class IndexPage.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/IndexPage.html#constructor">IndexPage</a></b>(videoDataController, focusController)
							</div>
							<div class="description">The constructor for the index page, sets up the side bar and grid</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class IndexPage.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getFocusController">getFocusController</a></b>()
								</div>
								<div class="description">Get the FocusController for the page</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getGridController">getGridController</a></b>()
								</div>
								<div class="description">Get the GridController</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getGridItemSelectedCallback">getGridItemSelectedCallback</a></b>()
								</div>
								<div class="description">Returns a callback function to handle a grid item selection</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getSelectedCategoryIndex">getSelectedCategoryIndex</a></b>()
								</div>
								<div class="description">Get the selected category</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getSideNavController">getSideNavController</a></b>()
								</div>
								<div class="description">Get the SideNavController</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getSideNavItemSelectedCallback">getSideNavItemSelectedCallback</a></b>()
								</div>
								<div class="description">Returns a callback function  to handle category selection</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#getVideoDataController">getVideoDataController</a></b>()
								</div>
								<div class="description">Get the VideoDataController</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#initialiseFocus">initialiseFocus</a></b>()
								</div>
								<div class="description">Select the appropriate view to receive the initial focus</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#isEmbedded">isEmbedded</a></b>()
								</div>
								<div class="description">Check is the page is embedded within a native app</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#makeGrid">makeGrid</a></b>()
								</div>
								<div class="description">Make the grid and add it to the view</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#makeSideNav">makeSideNav</a></b>()
								</div>
								<div class="description">Make the side navigation bar and add it to the view</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#onGridItemSelected">onGridItemSelected</a></b>(index)
								</div>
								<div class="description">Callback when a grid item is selected</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#onMenuItemSelected">onMenuItemSelected</a></b>(selectedItem)
								</div>
								<div class="description">Callback when a menu item is selected</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setEmbedded">setEmbedded</a></b>(isEmbedded)
								</div>
								<div class="description">Set whether the page is embedded within a native app or not</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setFocusController">setFocusController</a></b>(controller)
								</div>
								<div class="description">Set the FocusController to be used in the page</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setGridController">setGridController</a></b>(controller)
								</div>
								<div class="description">Set the GridController</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setSelectedCategoryIndex">setSelectedCategoryIndex</a></b>(index)
								</div>
								<div class="description">Set the selected category index (i.e.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setSideNavController">setSideNavController</a></b>(controller)
								</div>
								<div class="description">Set the SideNavController for the left hand side navigation</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setUpKeyHandling">setUpKeyHandling</a></b>()
								</div>
								<div class="description">This method will set up any additional key handling (i.e.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setUpPageState">setUpPageState</a></b>()
								</div>
								<div class="description">Set up the initial state of the page</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/IndexPage.html#setVideoDataController">setVideoDataController</a></b>(controller)
								</div>
								<div class="description">Set the VideoDataController</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>IndexPage</b>(videoDataController, focusController)
				</div>
				
				<div class="description">
					The constructor for the index page, sets up the side bar and grid
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{<a href="../symbols/VideoDataController.html">VideoDataController</a>}</span>  <b>videoDataController</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{<a href="../symbols/FocusController.html">FocusController</a>}</span>  <b>focusController</b>
								
							</dt>
								<dd></dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="getFocusController"> </a>
					<div class="fixedFont">
					
					
					<b>getFocusController</b>()
					
					</div>
					<div class="description">
						Get the FocusController for the page
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getGridController"> </a>
					<div class="fixedFont">
					
					
					<b>getGridController</b>()
					
					</div>
					<div class="description">
						Get the GridController
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getGridItemSelectedCallback"> </a>
					<div class="fixedFont">
					
					
					<b>getGridItemSelectedCallback</b>()
					
					</div>
					<div class="description">
						Returns a callback function to handle a grid item selection
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getSelectedCategoryIndex"> </a>
					<div class="fixedFont">
					
					
					<b>getSelectedCategoryIndex</b>()
					
					</div>
					<div class="description">
						Get the selected category
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getSideNavController"> </a>
					<div class="fixedFont">
					
					
					<b>getSideNavController</b>()
					
					</div>
					<div class="description">
						Get the SideNavController
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getSideNavItemSelectedCallback"> </a>
					<div class="fixedFont">
					
					
					<b>getSideNavItemSelectedCallback</b>()
					
					</div>
					<div class="description">
						Returns a callback function  to handle category selection
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getVideoDataController"> </a>
					<div class="fixedFont">
					
					
					<b>getVideoDataController</b>()
					
					</div>
					<div class="description">
						Get the VideoDataController
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="initialiseFocus"> </a>
					<div class="fixedFont">
					
					
					<b>initialiseFocus</b>()
					
					</div>
					<div class="description">
						Select the appropriate view to receive the initial focus
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="isEmbedded"> </a>
					<div class="fixedFont">
					
					
					<b>isEmbedded</b>()
					
					</div>
					<div class="description">
						Check is the page is embedded within a native app
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="makeGrid"> </a>
					<div class="fixedFont">
					
					
					<b>makeGrid</b>()
					
					</div>
					<div class="description">
						Make the grid and add it to the view
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="makeSideNav"> </a>
					<div class="fixedFont">
					
					
					<b>makeSideNav</b>()
					
					</div>
					<div class="description">
						Make the side navigation bar and add it to the view
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onGridItemSelected"> </a>
					<div class="fixedFont">
					
					
					<b>onGridItemSelected</b>(index)
					
					</div>
					<div class="description">
						Callback when a grid item is selected
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{int}</span> <b>index</b>
									
								</dt>
								<dd>The index of the selected item</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="onMenuItemSelected"> </a>
					<div class="fixedFont">
					
					
					<b>onMenuItemSelected</b>(selectedItem)
					
					</div>
					<div class="description">
						Callback when a menu item is selected
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{int}</span> <b>selectedItem</b>
									
								</dt>
								<dd>The index of the selected item</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setEmbedded"> </a>
					<div class="fixedFont">
					
					
					<b>setEmbedded</b>(isEmbedded)
					
					</div>
					<div class="description">
						Set whether the page is embedded within a native app or not
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>isEmbedded</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setFocusController"> </a>
					<div class="fixedFont">
					
					
					<b>setFocusController</b>(controller)
					
					</div>
					<div class="description">
						Set the FocusController to be used in the page
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/FocusController.html">FocusController</a>}</span> <b>controller</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setGridController"> </a>
					<div class="fixedFont">
					
					
					<b>setGridController</b>(controller)
					
					</div>
					<div class="description">
						Set the GridController
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/GridController.html">GridController</a>}</span> <b>controller</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setSelectedCategoryIndex"> </a>
					<div class="fixedFont">
					
					
					<b>setSelectedCategoryIndex</b>(index)
					
					</div>
					<div class="description">
						Set the selected category index (i.e. the category on the left hand side)
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{int}</span> <b>index</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setSideNavController"> </a>
					<div class="fixedFont">
					
					
					<b>setSideNavController</b>(controller)
					
					</div>
					<div class="description">
						Set the SideNavController for the left hand side navigation
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/SideNavController.html">SideNavController</a>}</span> <b>controller</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setUpKeyHandling"> </a>
					<div class="fixedFont">
					
					
					<b>setUpKeyHandling</b>()
					
					</div>
					<div class="description">
						This method will set up any additional key handling (i.e. Android key handling)
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setUpPageState"> </a>
					<div class="fixedFont">
					
					
					<b>setUpPageState</b>()
					
					</div>
					<div class="description">
						Set up the initial state of the page
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setVideoDataController"> </a>
					<div class="fixedFont">
					
					
					<b>setVideoDataController</b>(controller)
					
					</div>
					<div class="description">
						Set the VideoDataController
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/VideoDataController.html">VideoDataController</a>}</span> <b>controller</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Aug 28 2012 18:44:07 GMT+0100 (BST)
		</div>
	</body>
</html>
